
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>validate-multicast</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>validate-multicast</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="validate-dcom.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="verify-domain-xml.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="validate-multicast-1"></a><a id="GSRFM00259"></a><a id="validate-multicast"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_validate_multicast">validate-multicast</h2>
<div class="sectionbody">
<div class="paragraph">
<p>validates that multicast transport is available for clusters</p>
</div>
<div id="sthref2332" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] validate-multicast [--help]
[--multicastport multicastport]
[--multicastaddress multicastaddress]
[--bindaddress bindaddress]
[--sendperiod sendperiod]
[--timeout timeout]
[--timetolive timetolive]
[--verbose={false|true}]</code></pre>
</div>
</div>
<div id="sthref2333" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>validate-multicast</code> subcommand validates that multicast transport
is available for clusters. You should run this subcommand at the same
time on each of the hosts to be validated. This subcommand is available
in local mode.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>Do not run the <code>validate-multicast</code> subcommand using the DAS and
cluster&#8217;s multicast address and port values while the DAS and cluster
are running. Doing so results in an error.</p>
</div>
<div class="paragraph">
<p>The <code>validate-multicast</code> subcommand must be run at the same time on two
or more machines to validate whether multicast messages are being
received between the machines.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>As long as all machines see each other, multicast is validated to be
working properly across the machines. If the machines are not seeing
each other, set the <code>--bindaddress</code> option explicitly to ensure that all
machines are using interface on same subnet, or increase the
<code>--timetolive</code> option from the default of <code>4</code>. If these changes fail to
resolve the multicast issues, ask the network administrator to verify
that the network is configured so the multicast messages can be seen
between all the machines used to run the cluster.</p>
</div>
<div id="sthref2334" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--multicastport</code></dt>
<dd>
<p>The port for the multicast socket on which the Group Management
Service (GMS) listens for group events. Specify a standard UDP port
number in the range 2048-49151. The default is <code>2048</code>.</p>
</dd>
<dt class="hdlist1"><code>--multicastaddress</code></dt>
<dd>
<p>The address for the multicast socket on which the GMS listens for
group events. Specify a class D IP address. Class D IP addresses are
in the range <code>224.0.0.0</code> to <code>239.255.255.255</code>, inclusive. The address
<code>224.0.0.0</code> is reserved and should not be used. The default is
<code>228.9.3.1</code>.</p>
</dd>
<dt class="hdlist1"><code>--bindaddress</code></dt>
<dd>
<p>The local interface to receive multicast datagram packets for the GMS.
The default is to use all available binding interfaces.<br>
On a multi-home machine (possessing two or more network interfaces),
this attribute enables you to indicate which network interface is used
for the GMS. This value must be a local network interface IP address.</p>
</dd>
<dt class="hdlist1"><code>--sendperiod</code></dt>
<dd>
<p>The number of milliseconds between test messages sent between nodes.
The default is <code>2000</code>.</p>
</dd>
<dt class="hdlist1"><code>--timeout</code></dt>
<dd>
<p>The number of seconds before the subcommand times out and exits. The
default is <code>20</code>. You can also exit this subcommand using Ctrl-C.</p>
</dd>
<dt class="hdlist1"><code>--timetolive</code></dt>
<dd>
<p>The default time-to-live for multicast packets sent out on the
multicast socket in order to control the scope of the multicasts. The
time-to-live value must be between zero and 255 inclusive. The default
is the JDK default or a minimum defined by a constant in the GMS
subsystem, whichever is lower. To see the time-to-live value being
used, use the <code>--verbose</code> option.</p>
</dd>
<dt class="hdlist1"><code>--verbose</code></dt>
<dd>
<p>If used without a value or set to <code>true</code>, provides additional
debugging information. The default is <code>false</code>.</p>
</dd>
</dl>
</div>
<div id="sthref2335" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM798"></a><a id="sthref2336"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Validating multicast transport</p>
</div>
<div class="paragraph">
<p>Run from host <code>machine1</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; validate-multicast
Will use port 2,048
Will use address 228.9.3.1
Will use bind address null
Will use wait period 2,000 (in milliseconds)

Listening for data...
Sending message with content "machine1" every 2,000 milliseconds
Received data from machine1 (loopback)
Received data from machine2
Exiting after 20 seconds. To change this timeout, use the --timeout command line option.
Command validate-multicast executed successfully</code></pre>
</div>
</div>
<div class="paragraph">
<p>Run from host <code>machine2</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; validate-multicast
Will use port 2,048
Will use address 228.9.3.1
Will use bind address null
Will use wait period 2,000 (in milliseconds)

Listening for data...
Sending message with content "machine2" every 2,000 milliseconds
Received data from machine2 (loopback)
Received data from machine1
Exiting after 20 seconds. To change this timeout, use the --timeout command line option.
Command validate-multicast executed successfully</code></pre>
</div>
</div>
<div id="sthref2337" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2338" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="get-health.html#get-health-1"><code>get-health</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="validate-dcom.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="verify-domain-xml.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
